GET WellPurposes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves well purposes for the given parameters. This will only retrieve well purposes that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
take |
Number of well purposes to retrieve. Default is all well purposes |
integer |
None. |
skip |
Number of well purposes to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the well purposes before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of well purposes.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of WellPurpose |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "WellPurposeId": "790d8e8e-4e22-4ea2-b83a-bcd22ee3958f", "Asset": { "AssetId": "51575218-c52e-4cd6-9c81-63edbe973421", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8d4ae516-deae-44e7-b165-08668a86e655", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5e9c126-22d1-4389-b3b1-ae5e7eb26d48", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "bde4df9d-085b-436b-b794-56b6fd17d6e6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "MeasurementValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "SourceSystemId": "sample string 3", "CompanyId": "97e44f4b-0fec-4283-bc05-5ec4bd80c952", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "d5a25dcc-150a-4e45-b919-90e569bd69c2", "EffectiveDate": "2024-04-29T00:15:28.648218-07:00", "StateType": { "StateTypeId": "dc2d5b52-73d6-420b-bb34-3adf3e95a32a", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8d4ae516-deae-44e7-b165-08668a86e655", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5e9c126-22d1-4389-b3b1-ae5e7eb26d48", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a2c469c1-0d07-4bb4-9f69-2a685fdbf487", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d344b2d0-b051-4270-969f-42bf4f57f4c4", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "dd8ab66d-16b8-4b88-a43f-e877ac5e4d0b", "EffectiveDate": "2024-04-29T00:15:28.648218-07:00", "StatusType": { "StatusTypeId": "acaf8ca1-94da-48c0-8282-7190b77cbee1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8d4ae516-deae-44e7-b165-08668a86e655", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5e9c126-22d1-4389-b3b1-ae5e7eb26d48", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "977f0f2b-c953-4f9e-8120-4e29831ce99a", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "513b4285-95c3-4ddb-9e42-093a9dfb366a", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "MeasurementValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e9e8819f-32e5-42bf-b18d-b95680fd4b86", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-29T00:15:28.648218-07:00", "WellPurposeType": { "WellPurposeTypeId": "90ed0694-7362-44c0-ac01-30492a2c23d1", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3ba283fe-946c-4457-bfcf-9f05cfa90a5b", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4afefe9f-f9ba-4008-8976-29857f6ae0b6", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 4" }, { "WellPurposeId": "790d8e8e-4e22-4ea2-b83a-bcd22ee3958f", "Asset": { "AssetId": "51575218-c52e-4cd6-9c81-63edbe973421", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8d4ae516-deae-44e7-b165-08668a86e655", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5e9c126-22d1-4389-b3b1-ae5e7eb26d48", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "bde4df9d-085b-436b-b794-56b6fd17d6e6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "MeasurementValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "SourceSystemId": "sample string 3", "CompanyId": "97e44f4b-0fec-4283-bc05-5ec4bd80c952", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "d5a25dcc-150a-4e45-b919-90e569bd69c2", "EffectiveDate": "2024-04-29T00:15:28.648218-07:00", "StateType": { "StateTypeId": "dc2d5b52-73d6-420b-bb34-3adf3e95a32a", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8d4ae516-deae-44e7-b165-08668a86e655", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5e9c126-22d1-4389-b3b1-ae5e7eb26d48", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a2c469c1-0d07-4bb4-9f69-2a685fdbf487", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d344b2d0-b051-4270-969f-42bf4f57f4c4", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "dd8ab66d-16b8-4b88-a43f-e877ac5e4d0b", "EffectiveDate": "2024-04-29T00:15:28.648218-07:00", "StatusType": { "StatusTypeId": "acaf8ca1-94da-48c0-8282-7190b77cbee1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8d4ae516-deae-44e7-b165-08668a86e655", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5e9c126-22d1-4389-b3b1-ae5e7eb26d48", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "977f0f2b-c953-4f9e-8120-4e29831ce99a", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "513b4285-95c3-4ddb-9e42-093a9dfb366a", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "MeasurementValueNeededDate": "2024-04-29T00:15:28.648218-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e9e8819f-32e5-42bf-b18d-b95680fd4b86", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-29T00:15:28.648218-07:00", "WellPurposeType": { "WellPurposeTypeId": "90ed0694-7362-44c0-ac01-30492a2c23d1", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3ba283fe-946c-4457-bfcf-9f05cfa90a5b", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4afefe9f-f9ba-4008-8976-29857f6ae0b6", "CreateDate": "2024-04-29T00:15:28.648218-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-29T00:15:28.648218-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }